API docs #132
Open
API docs #132
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
August 7, 2021 10:30
commit 7ca2647 Author: Dilawar Singh <[email protected]> Date: Sat Aug 7 10:19:55 2021 +0530 reverted toy_example.py commit e1bba0e Author: Dilawar Singh <[email protected]> Date: Sat Aug 7 10:19:41 2021 +0530 Added readthedocs files.
40 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR creates API doc using
sphinx. A few files are added todocsfolder to automate the process.Then generated API docs are at https://epimargin.readthedocs.io/en/latest/index.html. If you want to use this flow for API docs, let me know you readthedocs username, I'll transfer the project to you.
Other alternatives are fine as well.
API doc is a required checklist on openjournals/joss-reviews#3464